/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.exception;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;

import javax.xml.namespace.QName;

import org.apache.xmlbeans.XmlObject;

import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.addressing.RelatesToDocument;

/** The exception maps a SOAP Fault exception. All the elements that are
    part of a Fault can be set through this exception.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.5 $
*/

public class WsFaultException extends Exception {

  private QName faultCodeQName;
  private String reason;  
  private XmlObject detailObject;

  private String faultActor;
  private EndpointReferenceType faultTo;
  
  private RelatesToDocument relatesTo;
  private XmlObject addSoapHeaderElement;

  private String errorCode;
  
  public WsFaultException(QName faultCodeQName, String reason) {
    this.faultCodeQName = faultCodeQName;
    this.reason = reason;
  }
  
  public WsFaultException(QName faultCodeQName, String reason,
			  EndpointReferenceType faultTo) {
    this.faultCodeQName = faultCodeQName;
    this.reason = reason;
    this.faultTo = faultTo;
  }
  
  public WsFaultException(QName faultCodeQName, String reason, 
			  XmlObject detailObject,
			  EndpointReferenceType faultTo) {
    this.faultCodeQName = faultCodeQName;
    this.reason = reason;
    this.detailObject = detailObject;
    this.faultTo = faultTo;
    
  }
  

  public QName getFaultCodeQName() {
    return faultCodeQName;
  }

  public String getReason() {
    return reason;
  }

  
  public EndpointReferenceType getFaultTo() {
    return faultTo;
  }

  public boolean hasFaultTo() {
    if (faultTo != null) {
      return true;
    }
    return false;
  }
  
  public void setFaultTo(EndpointReferenceType faultTo) {
    this.faultTo = faultTo;
  }
  
  
  public XmlObject getDetailObject() {
    return detailObject;
  }
  
  
  public boolean hasDetailObject() {
    if (detailObject != null) {
      return true;
    }
    return false;
  }
  
  public void setDetailObject(XmlObject detailObject) {
    this.detailObject = detailObject;
  }



  public void setFaultActor(String faultActor) {
    this.faultActor = faultActor;
  }
  
  public boolean hasFaultActor() {
    if (faultActor != null) {
      return true;
    }
    return false;
  }

  
  public String getFaultActor() {
    return faultActor;
  }
  

  public void setRelatesTo(RelatesToDocument relatesTo) {
    this.relatesTo = relatesTo;
  }
  
  
  public boolean hasRelatesTo() {
    if (relatesTo != null) {
      return true;
    }
    return false;
  }
  
  
  public RelatesToDocument getRelatesTo() {
    return relatesTo;
  }

  
  /** This is useful especially in the case of WSRM faults, where it is
      expected to send the fault:SubCode wrapped within a SequenceFault
      element in the header of the SOAP message carrying the FAULT. */
  public void setAddSoapHeaderElement(XmlObject addSoapHeaderElement) {
    this.addSoapHeaderElement = addSoapHeaderElement;
  }

  public boolean hasAddSoapHeaderElement() {
    if (addSoapHeaderElement == null) {
      return false;
    }    
    return true;
  }

  public XmlObject getAddSoapHeaderElement() {
    return addSoapHeaderElement;
  }
  
  public String toString() {
    String stringRepresentation = "->" + reason;
    if (errorCode != null)
      stringRepresentation += (" ErrorCode => " + errorCode);
    return stringRepresentation;
  }
  
  /** Gets the stack trace associated with the exception */
  public String getStackTraceAsString() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    PrintStream printStream = new PrintStream(baOutputStream);
    this.printStackTrace(printStream);
    return baOutputStream.toString();
  }
  
}





